.TH E1432_SET_PEAK_HOLD_TIME 3 E1432
.SH NAME
.nf
e1432_set_peak_hold_time \- Set peak hold time
e1432_get_peak_hold_time \- Get peak hold time
.fi
.IX e1432_set_peak_hold_time(3) 3
.IX e1432_get_peak_hold_time(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_set_peak_hold_time(E1432ID hw, SHORTSIZ16 ID,
FLOATSIZ32 hold)
SHORTSIZ16 e1432_get_peak_hold_time(E1432ID hw, SHORTSIZ16 ID,
FLOATSIZ32 *hold)
.cE
.SH DESCRIPTION
The E1432 option 204 4-channel 51.2 kHz input SCA is the only SCA to
support this function.

\fIe1432_set_peak_hold_time\fR sets the hold time for the peak detector.
A peak value is held for the specified hold time if a higher peak value
does not occur during that hold time.  At the end of the hold time the
peak value for output will be set to the highest peak value within the last
1/4 of the hold time and held for the specified hold time from when it was
detected.  If at any time during the holding process a peak value is
greater than the peak value being held, then that becomes the new peak
value and the hold time counter is reset.

\fIe1432_get_peak_hold_time\fR returns the current hold time setting in
seconds.  All channels of a module have the same hold time.

Note: The peak detect algorithm is may be preceeded by a digital high-pass
filter (see e1432_set_peak_span, e1432_set_hpf_span ).

The valid values for hold depend upon the data rate of the span on which
the peak detection is done.  The valid values are from 0 sec. to
((2^23-4)/span_sample_rate) sec. in steps  of (4/span_sample_rate) sec.

This parameter is a "global" parameter.  It applies to an entire E1432
module rather than to one of its channels.  The \fIID\fR parameter is
used only to identify which module the function applies to, and all
channels in that module will report the same value for this parameter.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained with a
call to \fIe1432_create_channel_group\fR, or the ID of a single
channel.

\fIhold\fR is the desired hold time in seconds.

.SH "RESET VALUE"
After a reset, each module is set to 1 sec. hold time.
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_set_peak_span, e1432_set_coupling_freq, e1432_set_hpf_span
.ad
